Sendbird UIKit/com.sendbird.uikit.vm/OpenChannelViewModel

OpenChannelViewModel

open class OpenChannelViewModel : BaseViewModel, OnPagedDataLoader<T>

ViewModel preparing and managing data related with the list of messages in an open channel since 3.0.0

Constructors

open fun OpenChannelViewModel(@NonNull channelUrl: String, @Nullable messageListParams: MessageListParams)

Constructor

Functions

authenticate

open fun authenticate(@NonNull handler: AuthenticateHandler)

Tries to connect Sendbird Server and retrieve a channel instance.

createMessageListParams

@NonNull

open fun createMessageListParams(): MessageListParams

Creates params for the message list when loading the message list.

deleteMessage

open fun deleteMessage(@NonNull message: BaseMessage, @Nullable handler: OnCompleteHandler)

Deletes a message.

enterChannel

open fun enterChannel(@NonNull channel: OpenChannel, @NonNull handler: OnCompleteHandler)

Try enter this channel.

getMessageList

@NonNull

open fun getMessageList(): LiveData<List<BaseMessage>>

Returns LiveData that can be observed for the list of messages.

getMessageLoadState

@NonNull

open fun getMessageLoadState(): LiveData<MessageLoadState>

Returns LiveData that can be observed for the state of loading messages.

getMyMutedInfo

@NonNull

open fun getMyMutedInfo(): LiveData<Boolean>

Returns LiveData that can be observed if the current user is muted or not.

getStatusFrame

@NonNull

open fun getStatusFrame(): LiveData<StatusFrameView.Status>

Returns LiveData that can be observed for the status of the result of fetching the message list.

hasNext

open fun hasNext(): Boolean

Returns false as the message list for OpenChannel do not support to load for the next by default.

hasPrevious

open fun hasPrevious(): Boolean

Determine whether the data on the previous page exists.

loadInitial

open fun loadInitial()

Requests the list of BaseMessages for the first time.

loadNext

@NonNull

open fun loadNext(): List<BaseMessage>

Returns the empty list as the message list for OpenChannel do not support to load for the next by default.

loadPrevious

@NonNull

open fun loadPrevious(): List<BaseMessage>

Requests the list of BaseMessages when the page goes to the previous.

onChannelDeleted

@NonNull

open fun onChannelDeleted(): LiveData<Boolean>

Returns LiveData that can be observed if the channel has been deleted.

onChannelUpdated

@NonNull

open fun onChannelUpdated(): LiveData<OpenChannel>

Returns LiveData that can be observed if the channel has been updated.

onCleared

protected open fun onCleared()

onMessageDeleted

@NonNull

open fun onMessageDeleted(): LiveData<Long>

Returns LiveData that can be observed if the messages has been deleted.

resendMessage

open fun resendMessage(@NonNull message: BaseMessage, @Nullable handler: OnCompleteHandler)

Resends a message to the channel.

sendFileMessage

open fun sendFileMessage( @NonNull params: FileMessageCreateParams, @NonNull fileInfo: FileInfo, @Nullable handler: OnFilteringMessageHandler)

Sends a file message to the channel.

sendUserMessage

open fun sendUserMessage(@NonNull params: UserMessageCreateParams, @Nullable handler: OnFilteringMessageHandler)

Sends a text message to the channel.

updateUserMessage

open fun updateUserMessage( messageId: Long, @NonNull params: UserMessageUpdateParams, @Nullable handler: OnCompleteHandler)

Updates a text message with messageId.

Properties

channel

@Nullable

@get:Nullable

open val channel: OpenChannel

channelUrl

@NonNull

@get:NonNull

val channelUrl: String